API Documentation
Public Member Functions | List of all members
nkWinUi::GraphicsWindow Class Referenceabstract

A graphical window made to receive 3d rendering contexts. More...

Inheritance diagram for nkWinUi::GraphicsWindow:
nkWinUi::Component nkExport::Exportable

Public Member Functions

 GraphicsWindow ()
 
 ~GraphicsWindow ()
 
virtual HWND getHwnd () const
 
void setCloseCallback (const closeCallback &callback)
 
void setResizeCallback (const resizeCallback &callback)
 
void setMouseLeaveCallback (const mouseLeaveCallback &callback)
 
void setNoBorder (bool value)
 
virtual void maximize (bool val)=0
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
ThemegetTheme () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getAreaInParent () const
 
nkMaths::Rectangle getAreaInScreen () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
nkMemory::StringView getComponentName () const
 
bool getVisibility () const
 
virtual nkMemory::StringView getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setTheme (Theme *theme)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setAreaInParent (const nkMaths::Rectangle &area)
 
virtual void setAreaInScreen (const nkMaths::Rectangle &area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const nkMemory::StringView &label)
 
void setComponentName (const nkMemory::StringView &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage (bool withFrame=false)
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical window made to receive 3d rendering contexts.

Used within nkGraphics::RenderContext.

Constructor & Destructor Documentation

◆ GraphicsWindow()

nkWinUi::GraphicsWindow::GraphicsWindow ( )

Constructor.

Remarks
See ComponentManager::createOrRetrieve().

◆ ~GraphicsWindow()

nkWinUi::GraphicsWindow::~GraphicsWindow ( )

Destructor.

Member Function Documentation

◆ getHwnd()

virtual HWND nkWinUi::GraphicsWindow::getHwnd ( ) const
virtual
Returns
The HWND attached to the window, if available.
Remarks
This is dependant on the system used. HWND is a Windows structure.

◆ setCloseCallback()

void nkWinUi::GraphicsWindow::setCloseCallback ( const closeCallback callback)

Sets the close callback for the component. Will be called over the one set in the InputSystem.

Parameters
callbackThe callback to set.

◆ setResizeCallback()

void nkWinUi::GraphicsWindow::setResizeCallback ( const resizeCallback callback)

Sets the resize callback for the component. Will be called over the one set in the InputSystem.

Parameters
callbackThe callback to set.

◆ setMouseLeaveCallback()

void nkWinUi::GraphicsWindow::setMouseLeaveCallback ( const mouseLeaveCallback callback)

Sets the mouse leave callback for the component. Will be called over the one set in the InputSystem.

Parameters
callbackThe callback to set.

◆ setNoBorder()

void nkWinUi::GraphicsWindow::setNoBorder ( bool  value)

Sets whether the window should have a border and a system bar, or not.

Parameters
valueIf the window should have no border (true) or not (false).

◆ maximize()

virtual void nkWinUi::GraphicsWindow::maximize ( bool  val)
pure virtual

Maximizes the window on screen.

Parameters
valIf the window should be maximized (true) or minimized (false).

◆ exportIntrospection()

virtual void nkWinUi::GraphicsWindow::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::GraphicsWindow::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: